Skip to content

docs(readme): add CI/release/quality/version/license badges#26

Merged
cicdteam merged 1 commit into
mainfrom
readme-badges
May 23, 2026
Merged

docs(readme): add CI/release/quality/version/license badges#26
cicdteam merged 1 commit into
mainfrom
readme-badges

Conversation

@cicdteam

Copy link
Copy Markdown
Contributor

Summary

Adds 5 badges to the top of README, immediately under the H1 title:

  1. CI - live status of ci.yml workflow
  2. Release - latest GitHub release (currently v0.1.0)
  3. Go Report Card - static-analysis grade (first hit triggers report generation)
  4. Go Version - go 1.26.3 from go.mod
  5. License - Apache-2.0 from LICENSE

All are standard shields.io / GitHub Actions / goreportcard.com URLs. No 3rd-party badge services with reliability concerns.

Skipped: stars/downloads/issues (vanity for v0.1), pkg.go.dev (CLI not library), OpenSSF Scorecard (needs enrollment), Homebrew/Docker (no public stats - would be static-text only).

Test plan

  • All 5 badge images render on the rendered README (GitHub renders shields.io + goreportcard inline)
  • CI badge reflects current workflow state (green right now)
  • Release badge picks up v0.1.0
  • Go Report Card link resolves; first click generates the report
  • License badge shows Apache-2.0

@cicdteam cicdteam merged commit d976689 into main May 23, 2026
4 checks passed
@cicdteam cicdteam deleted the readme-badges branch May 23, 2026 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant